<!doctype html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta http-equiv="x-ua-compatible" content="ie=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
    <title>Home | phpDocumentor</title>
    <meta name="description" content="Documentation Generator for PHP">
    <meta property="og:title" content="Home">
    <meta property="og:description" content="Documentation Generator for PHP">
    <meta property="og:type" content="website">
    <meta name="twitter:card" content="summary">
    <meta name="twitter:creator" content="@phpDocumentor">
    <meta name="twitter:title" content="Home">
    <meta name="twitter:description" content="Documentation Generator for PHP">
    <link rel="apple-touch-icon" sizes="180x180" href="apple-touch-icon.png">
    <link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png">
    <link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png">
    <link rel="manifest" href="site.webmanifest">
    <link rel="mask-icon" href="safari-pinned-tab.svg" color="#8ed45f">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="theme-color" content="#ffffff">
    <link rel="stylesheet" href="https://docs.phpdoc.org/3.0/css/normalize.css?v=3">
    <link rel="stylesheet" href="https://docs.phpdoc.org/3.0/css/base.css?v=3">
    <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&amp;display=swap" rel="stylesheet">
    <link rel="stylesheet" href="css/template.css?v=5">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.2/css/all.min.css" integrity="sha384-PPIZEGYM1v8zp5Py7UjFb79S58UeqCL9pYVnVPURKEqvioPROaVAJKKLzvH2rDnI" crossorigin="anonymous">
    <script

            src="https://analytics.phpdoc.org/api/script.js"
            data-site-id="1"
            defer
    ></script>
    <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
</head>
<body>
<header class="phpdocumentor-header phpdocumentor-section">

    <h1 class="phpdocumentor-title -without-divider">
        <a class="phpdocumentor-title__link" href="/3.0/">
            <img src="">
            phpDocumentor
        </a>
    </h1>

    <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
    <label class="phpdocumentor-header__menu-icon" for="menu-button">
        <i class="fas fa-bars"></i>
    </label>

    <nav class="phpdocumentor-topnav">
        <ul class="phpdocumentor-topnav__menu">
            <li class="phpdocumentor-topnav__menu-item"><a href="//phpdoc.org"><span>About</span></a></li>
            <li class="phpdocumentor-topnav__menu-item"><a href="//phpdoc.org#sponsors"><span>Sponsors</span></a></li>
            <li class="phpdocumentor-topnav__menu-item"><a href="/components.html"><span>Components</span></a></li>
            <li class="phpdocumentor-topnav__menu-item"><a href="//docs.phpdoc.org"><span>Documentation</span></a></li>
            <li class="phpdocumentor-topnav__menu-item -social">
                <a href="https://phpc.social/@phpdoc">
                    <i class="fab fa-mastodon"></i>
                </a>
            </li>
            <li class="phpdocumentor-topnav__menu-item -social">
                <a href="https://github.com/phpdocumentor/phpdocumentor">
                    <i class="fab fa-github"></i>
                </a>
            </li>

            <li class="phpdocumentor-topnav__menu-item -social">
                <a href="https://github.com/orgs/phpDocumentor/discussions">
                    <i class="fas fa-envelope-open-text"></i>
                </a>
            </li>
        </ul>
    </nav>
</header>

<section class="phpdocumentor-section phpdocumentor-hero">
    <section class="phpdocumentor-hero__blurb">
        <h2 class="phpdocumentor-hero__blurb-title">Because<br><em>code</em> and <em>documentation</em><br>are meant to be together.</h2>
        <p class="phpdocumentor-hero__blurb-slogan">
            phpDocumentor is the de-facto documentation application for PHP
            projects. Your project can benefit too from more than 20 years of experience and setting the standard
            for documenting PHP Applications.
        </p>
        <a class="phpdocumentor-button -primary" href="//docs.phpdoc.org/3.0/">
            <i class="fas fa-book"></i>
            Documentation
        </a>
    </section>
    <section class="phpdocumentor-hero__illustration"><img src="images/hero-illustration.svg"></section>
</section>

<main class="phpdocumentor">
    <section class="phpdocumentor-diagonal">
        <section class="phpdocumentor-section phpdocumentor-content">
            <article class="phpdocumentor-features">
                <h2>Features<small>What can phpDocumentor 3 do to help you with your documentation</small></h2>
                <img class="phpdocumentor-features__screenshot" src="images/screenshot.png" alt="Screenshot of what the output looks like">
                <ul class="phpdocumentor-features__list fa-ul">
                    <li>
                        <span class="fa-li"><i class="fas fa-check-circle"></i></span>
                        <h3>Super easy to install and use</h3>
                        <p>Thanks to the power of Docker or PHAR</p>
                    </li>
                    <li>
                        <span class="fa-li"><i class="fas fa-check-circle"></i></span>
                        <h3>Creates Beautiful Documentation</h3>
                        <p>
                            Learns everything about your code and uses that to make sure you have the best
                            documentation.
                        </p>
                    </li>
                    <li>
                        <span class="fa-li"><i class="fas fa-check-circle"></i></span>
                        <h3>UML Class Diagrams</h3>
                        <p>Gives you a UML Class Diagram for your project using PlantUML or GraphViz.</p>
                    </li>
                    <li>
                        <span class="fa-li"><i class="fas fa-check-circle"></i></span>
                        <h3>Supports PHP latest</h3>
                        <p>Supports the latest features that PHP has to offer.</p>
                    </li>
                    <li>
                        <span class="fa-li"><i class="fas fa-check-circle"></i></span>
                        <h3>More control using DocBlocks</h3>
                        <p>Uses the information from your DocBlocks to provide even more insight.</p>
                    </li>
                    <li>
                        <span class="fa-li"><i class="fas fa-check-circle"></i></span>
                        <h3>Full-Text Search</h3>
                        <p>Need to find that one method? Full-text search is supported, even offline.</p>
                    </li>
                    <li>
                        <span class="fa-li"><i class="fas fa-check-circle"></i></span>
                        <h3>CI Support out of the box</h3>
                        <p>Integrate it into your CI pipeline with our Github Action or Docker image</p>
                    </li>
                </ul>
            </article>
        </section>
    </section>

    <section class="phpdocumentor-section phpdocumentor-content">
        <article>
            <h2>Usage<small>Easy to install, and to use!</small></h2>
            <section class="phpdocumentor-side-by-side">
                <section>
                    <h3>Getting started using the PHAR</h3>
                    <p>
                        Start by downloading our latest <a href="phpDocumentor.phar">PHAR</a> file and giving it a
                        nice and cozy place on your hard drive.
                    </p>
                    <code>
                        <pre><span class="phpdocumentor-code__shell">$ </span>wget https://phpdoc.org/phpDocumentor.phar</pre>
                    </code>
                    <p>
                        After you downloaded the PHAR file, don't forget to power it up by making it executable.
                    </p>
                    <code>
                        <pre><span class="phpdocumentor-code__shell">$ </span>chmod +x phpDocumentor.phar</pre>
                    </code>
                    <blockquote>
                        Also, you may want to consider renaming it to <strong><code>phpdoc</code></strong>;
                        we'll understand.
                    </blockquote>
                    <p>Then, all you need to do is run it!</p>
                </section>
                <section>
                    <h3>Getting started using Docker</h3>
                    <p>
                        Use our very own <a href="https://hub.docker.com/r/phpdoc/phpdoc">Docker image</a>; no
                        installation needed!
                    </p>
                    <p>
                        Treat our docker image like you treat all your other utility images. Just don't forgot to
                        volume mount your current directory to <code>/data</code> inside the container. Remember: No
                        data, No docs.
                    </p>
                    <code>
                        <pre><span class="phpdocumentor-code__shell">$ </span>docker run --rm -v $<!-- -->{PWD}<!-- -->:/data phpdoc/phpdoc:3</pre>
                    </code>
                    <p>Tada!</p>
                </section>

                <section>
                    <h3>Using Composer</h3>
                    <p>
                        If you are using Composer to manage your project dependencies, you can also add
                        phpDocumentor as a development dependency using our shim package.
                        This will make sure you never have conflicts with other packages.
                    </p>
                    <code>
                        <pre><span class="phpdocumentor-code__shell">$ </span>composer require --dev phpdocumentor/shim</pre>
                        <pre><span class="phpdocumentor-code__shell">$ </span>./vendor/bin/phpdoc</pre>
                    </code>
                </section>
            </section>
        </article>
        <a class="phpdocumentor-button -primary" href="//docs.phpdoc.org/guide/getting-started/index.html">Learn more <i class="fas fa-forward"></i></a>
    </section>
    <section class="phpdocumentor-section phpdocumentor-content">
        <article>
            <h2 id="sponsors">Sponsors</h2>
            <p>
                phpDocumentor is an opensource project without any large funders.
                If you use this project we would love to receive your support via
                <a href="https://github.com/sponsors/phpDocumentor">GitHub Sponsors</a>.
                Your sponsorship will help us to keep the project alive.
            </p>

            <p>Our sponsors:</p>
            <ul class="phpdocumentor-sponsors">
                <li>
                    <a href="https://nexaa.io">
                        <img src="images/nexaa.svg" alt="Nexaa logo">
                    </a>
                </li>
                <li>
                    <a href="https://phpstorm.com">
                        <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/PhpStorm.svg" alt="PhpStorm logo">
                    </a>
                </li>
                <li>
                    <a href="https://ingewikkeld.dev">
                        <img src="images/ingewikkeld.svg" alt="Ingewikkeld logo">
                    </a>
                </li>
            </ul>
        </article>
    </section>
</main>

<section class="phpdocumentor-section">
    <img src="" class="phpdocumentor-footer__logo">
</section>
</body>
</html>
